FHIR IG analytics

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Examples of Use for Extension

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition artifact-versionAlgorithm

Name	Flags	Card.	Type	Description & Constraints
Extension		0..1	Extension	How to compare versions
extension		0..0		Extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm"
value[x]		1..1		Value of extension
valueString			string
valueCoding			Coding
Slices for value[x]				Content/Rules for all slices
value[x]:valueCoding		0..1	Coding	Value of extension Binding: VersionAlgorithm (extensible)
Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "artifact-versionAlgorithm",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cds"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "draft"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "can-bind"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.5.1738"
    }
  ],
  "version": "5.3.0-ballot-tc1",
  "name": "ArtifactVersionAlgorithm",
  "title": "Artifact Version Algorithm",
  "status": "draft",
  "experimental": false,
  "date": "2022-02-07",
  "publisher": "HL7 International / Clinical Decision Support",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description": "Indicates the mechanism used to compare versions to determine which is more current.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "purpose": "This extension is defined to support representing artifact metadata on resources that are not already canonical resources that have the corresponding element, and that behave in a definitional way. For example, it would not be appropriate to use this extension on a patient-specific resource such as MedicationRequest or CarePlan. For resources where this element was added in R5, the cross-version extension should be used rather than this extension (ActivityDefinition,CapabilityStatement,CodeSystem,CompartmentDefinition,ConditionDefinition,ConceptMap,ExampleScenario,GraphDefinition,ImplementationGuide,Library,Measure,MessageDefinition,NamingSystem,ObservationDefinition,OperationDefinition,PlanDefinition,Questionnaire,SearchParameter,SpecimenDefinition,SubscriptionTopic,StructureDefinition,StructureMap,TerminologyCapabilities,ValueSet).",
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "context": [
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "5.0"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "ArtifactAssessment"
    },
    {
      "type": "element",
      "expression": "ActivityDefinition"
    },
    {
      "type": "element",
      "expression": "CapabilityStatement"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "4.3"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "ClinicalUseDefinition"
    },
    {
      "type": "element",
      "expression": "CodeSystem"
    },
    {
      "type": "element",
      "expression": "CompartmentDefinition"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "5.0"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "ConditionDefinition"
    },
    {
      "type": "element",
      "expression": "ConceptMap"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "4.0"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "DeviceDefinition"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "4.0"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "ExampleScenario"
    },
    {
      "type": "element",
      "expression": "GraphDefinition"
    },
    {
      "type": "element",
      "expression": "Group"
    },
    {
      "type": "element",
      "expression": "ImplementationGuide"
    },
    {
      "type": "element",
      "expression": "Library"
    },
    {
      "type": "element",
      "expression": "Measure"
    },
    {
      "type": "element",
      "expression": "Medication"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "4.0"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "MedicationKnowledge"
    },
    {
      "type": "element",
      "expression": "MessageDefinition"
    },
    {
      "type": "element",
      "expression": "NamingSystem"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "4.0"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "ObservationDefinition"
    },
    {
      "type": "element",
      "expression": "OperationDefinition"
    },
    {
      "type": "element",
      "expression": "PlanDefinition"
    },
    {
      "type": "element",
      "expression": "Questionnaire"
    },
    {
      "type": "element",
      "expression": "SearchParameter"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "4.0"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "SpecimenDefinition"
    },
    {
      "type": "element",
      "expression": "Substance"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "4.3"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "SubstanceDefinition"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "4.3"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "SubscriptionTopic"
    },
    {
      "type": "element",
      "expression": "StructureDefinition"
    },
    {
      "type": "element",
      "expression": "StructureMap"
    },
    {
      "extension": [
        {
          "extension": [
            {
              "url": "startFhirVersion",
              "valueCode": "4.0"
            }
          ],
          "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
        }
      ],
      "type": "element",
      "expression": "TerminologyCapabilities"
    },
    {
      "type": "element",
      "expression": "ValueSet"
    }
  ],
  "type": "Extension",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation": "constraint",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "5.0.0"
      }
    ],
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "How to compare versions",
        "definition": "Indicates the mechanism used to compare versions to determine which is more current.",
        "comment": "If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Extension",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false
      },
      {
        "id": "Extension.id",
        "path": "Extension.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "id"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "condition": [
          "ele-1"
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Extension",
        "definition": "An Extension",
        "min": 0,
        "max": "0",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "isSummary": false
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "representation": [
          "xmlAttr"
        ],
        "short": "identifies the meaning of the extension",
        "definition": "Source of the definition for the extension code - a logical name or a URL.",
        "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.url",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "uri"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm",
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "slicing": {
          "discriminator": [
            {
              "type": "type",
              "path": "$this"
            }
          ],
          "ordered": false,
          "rules": "open"
        },
        "short": "Value of extension",
        "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          },
          {
            "code": "Coding"
          }
        ],
        "condition": [
          "ext-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.value[x]:valueCoding",
        "path": "Extension.value[x]",
        "sliceName": "valueCoding",
        "short": "Value of extension",
        "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Coding"
          }
        ],
        "condition": [
          "ext-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "binding": {
          "strength": "extensible",
          "valueSet": "http://hl7.org/fhir/ValueSet/version-algorithm"
        },
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "How to compare versions",
        "definition": "Indicates the mechanism used to compare versions to determine which is more current.",
        "comment": "If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.",
        "min": 0,
        "max": "1"
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "max": "0"
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm"
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "min": 1,
        "type": [
          {
            "code": "string"
          },
          {
            "code": "Coding"
          }
        ]
      },
      {
        "id": "Extension.value[x]:valueCoding",
        "path": "Extension.value[x]",
        "sliceName": "valueCoding",
        "type": [
          {
            "code": "Coding"
          }
        ],
        "binding": {
          "strength": "extensible",
          "valueSet": "http://hl7.org/fhir/ValueSet/version-algorithm"
        }
      }
    ]
  }
}